13.2 Changing email messages

You can edit the subject line and body of any of the provided email templates in MyID.

If you enable HTML format, you can send messages formatted in HTML (see section 13.1.2, Email format) including embedded images. You can also specify the code page if you want to send messages using character sets other than the standard ASCII characters (see section 13.1.3, Email codepage).

  1. Select the Configuration category and then the Email Templates workflow.

    You can also launch this workflow from the Connections and Notifications section of the More category in the MyID Operator Client. See the Using Connections and Notifications workflows section in the MyID Operator Client guide for details.

  2. Select the email template you want to edit. Click Modify.

    You are now in the Edit Email Template stage.

  3. Edit the Subject for the template.

    This forms the subject line of the email and must contain some information. You can use variables that are substituted when the template is run.

  4. Select or clear the Enabled option.

    If the Enabled option is cleared, the email specified by the template will not be sent.

  5. Type the Template Body.

    This is the body of the email. You can use variables that are substituted when the template is used; see section 13.2.1, Available variables for email messages.

    Note: Some variables are replaced by the same information in all templates; others are substituted by different information depending on the event that triggers the email message.

    For example, an email template like this:

    Your Certificate renewal date is soon approaching. You have %2 days to implement your Certificate Renewal procedure. %nPlease follow the instructions for renewing your certificate.

    Will generate a message like this:

    Your Certificate renewal date is soon approaching. You have 14 days to implement your Certificate Renewal procedure.
    Please follow the instructions for renewing your certificate.

  6. From the Transport drop-down list, select one of the following:

    • Email – the template is to be used for email messages.
    • SMS – the template is to be used for SMS messages.

  7. If the template is used to send auth codes, activation codes, or unlock codes, an additional option is available. Select the Complexity you want to use for the codes included in messages generated using this template:

    • Simple – the code is generated using the complexity rules as defined by the Simple Logon Code Complexity configuration option.

    • Complex – the code is generated using the complexity rules as defined by the Complex Logon Code Complexity configuration option.

    Note: This option is not available for templates used to send job collection codes. For job collection codes, the complexity is determined by the credential profile, or if the credential profile does not contain a complexity setting, by the Auth Code Complexity configuration option.

  8. If you want to sign the email message, select the Signed option.

    Note: You must have the Sign outgoing emails option for the SMTP server in the External Systems workflow set. See the Setting up email section in the Advanced Configuration Guide for details.

  9. Click Save.

13.2.1 Available variables for email messages

Variable

Description
%n

A new line.
%t

A tab.
%x

The URL of the MyID installation.

Not currently supported.
%u

The URL for mobile issuance.

This is the content of the Mobile Certificate Recovery Service URL configuration option.

%2,%3 and so on

Parameters that are substituted by the email trigger when the email is sent. For example, these might be the user’s name, the card serial number, or a comment entered in the workflow by an operator.

If the parameter value contains spaces (for example, a logon name) and you are using the parameter to build a URL (which does not allow spaces), you can use the following syntax to replace any spaces with + signs:

{%parameter:URI}

For example, {%logonName:URI} might become Jane+Smith.

Note: If you want to include additional parameters to the existing, standard email templates, this will require custom changes to MyID. Contact Intercede professional services for details.

13.2.2 URL encoded links

You can include URL encoded links in email notifications.

If, for example, you have an email notification that includes an URL containing %20 for a space or %3D for an = sign, you must escape these codes using %_ after the % sign – for example, %%_20 for space.